Start awareness heartbeat task to keep Websockets alive #131
Conversation
jzhang20133
requested review from
Zsailer and
dlqqq
and removed request for
Zsailer and
dlqqq
dlqqq
changed the title
| # Broadcast AwarenessUpdate message to all other synced clients | ||
| self._broadcast_message(message, message_type="AwarenessUpdate") | ||
|
|
There was a problem hiding this comment.
Great catch Jialin, thank you for removing this & the condition in _on_awareness_update().
I had to check the pycrdt source code (Awareness._emit()) to figure out why your PR works. The two deleted portions of code were used together to handle broadcasting awareness updates in two areas; this was done following the original implementation in jupyter_collaboration. But by removing those 2 portions of code, all of the broadcasting is now done in _on_awareness_update(). Fantastic! 👍
There was a problem hiding this comment.
The key fix is to turn on server awareness message asyncio.create_task(self._awareness.start()), previously we did not kick start this task so a server generated awareness message (like a ping message to keep client side aware of its aliveness) are not sent every 15 seconds. And yes, you are right, removing the condition in _on_awareness_update() will allow those server awareness message to be broadcasted. Last, removing the broadcast call in handle_awareness_update method is to prevent a client awareness message for broadcasted twice.
There was a problem hiding this comment.
Server side awareness messages will keep the ydoc websocket alive even if client side stops sending awareness messages due to browser background tab throttling.
2 participants
server side should send awareness message every 15 seconds but that task is not turned on. This PR will turn it on. Server side awareness messages will keep the ydoc websocket alive even if client side stops sending awareness messages due to browser background tab throttling.
Addressing the following issue when browser tab is not focused on:
#115